/**
 *  Copyright (C) 2008-2013  Telosys project org. ( http://www.telosys.org/ )
 *
 *  Licensed under the GNU LESSER GENERAL PUBLIC LICENSE, Version 3.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *          http://www.gnu.org/licenses/lgpl.html
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
package org.telosys.common.data;


/**
 * @author Laurent GUERIN
 * 
 * Provides getters to build dynamicaly list items<br>
 * A list item must provide a VALUE and a TEXT to populate Lists, ComboBoxes, ... 
 * 
 */
public interface ListItemProvider
{
    /**
     * Returns the number of rows of the ListItem provider
     * @return : row count
     */
    public int getRowCount();

    /**
     * Returns the item value for the given row  
     * @param iRow ( from 1 to RowCount )
     * @return item value
     */
    public String getListItemValue(int iRow);

    /**
     * Returns the item text for the given row (text to be shown in the combo/list)
     * @param iRow ( from 1 to RowCount )
     * @return item text
     */
    public String getListItemText(int iRow);
    
    /**
     * Notify the ListItem provider that it will be used
     */
    public void beforeUse();
    
    /**
     * Notify the ListItem provider that it has been used
     */
    public void afterUse();

}